package zzuli.edu.cn.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.env.Environment;
import org.springframework.core.env.Profiles;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class Swagger2Config {

    /**
     * 配置Swagger2的Docket实例
     * @return
     */
    @Bean
    public Docket createRestApi(Environment env) {
        // 判断当前环境是否是开发和测试环境
        Profiles profiles = Profiles.of("dev", "test");
        boolean isDevOrTest = env.acceptsProfiles(profiles);
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                // 设置分组名称
                .groupName("开发环境")
                // 设置是否启用Swagger2，默认为true
                .enable(isDevOrTest)
                .select()
                // 设置要扫描API的包
                .apis(RequestHandlerSelectors.basePackage("zzuli.edu.cn"))
                // 设置要生成API文档的路径
                .paths(PathSelectors.any())
                .build();
    }

    /**
     * 配置Swagger2的ApiInfo
     * @return
     */
    public ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("API接口文档")
                .description("Api Documentation")
                .version("1.0")
                .license("Apache 2.0")
                .licenseUrl("http://www.apache.org/licenses/LICENSE-2.0")
                .build();
    }

}

        // 配置扫描API的方式有如下四种：
        // 为当前包下的controller生成API文档
        // .apis(RequestHandlerSelectors.basePackage("zzuli.edu.cn"))
        // 为有@Api注解的Controller生成API文档
        // .apis(RequestHandlerSelectors.withClassAnnotation(Api.class))
        // 为有@ApiOperation注解的方法生成API文档
        // .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
        // 为任何接口生成API文档
        // .apis(RequestHandlerSelectors.any())
        // 不为任何接口生成API文档
        // .apis(RequestHandlerSelectors.none())

        // 配置要筛选过滤的路径有如下四种方式：
        // 为全部路径生成API文档
        // .paths(PathSelectors.any())
        // 不为任何路径生成API文档
        // .paths(PathSelectors.none())
        // 为符合正则表达式的路径生成API文档
        // .paths(PathSelectors.regex())
        // 为指定条件下的路径生成API文档
        // .paths(PathSelectors.ant())

        // 如何配置多个分组？
        // 只需要配置多个Docket即可
